v3.1.5

Compare Source

v3.1.4

Compare Source

v3.1.3

Compare Source

• Revert the changes made in #​3497, which have lead to problems with onCompleted being called more often than necessary.
  
  @​hwillson in 0901f4a

v3.1.2

Compare Source

Bug Fixes

• Make sure SSR is fully disabled when using ssr: false and ssrMode: true.
  
  @​maapteh in #​3515
• Fixed MockLink's broken newData function handling.
  
  @​pawelkleczek in #​3539
• Fixed an issue that prevented networkStatus from changing ready at the end of pagination.
  
  @​mu29 in #​3514

v3.1.1

Compare Source

Improvements

• Calling startPolling or stopPolling after a component has unmounted is now a no-op (instead of throwing an exception). Polling is automatically stopped when a component is unmounted, so it doesn't need to be called manually.
  
  @​hwillson in #​3485
• Allow ignoreResults to be controlled through graphql and withMutation options.
  
  @​tim-stasse in #​3431
• Be a bit more defensive when it comes to accessing the internal
  ObservableQuery instance, to avoid attempting to use it after a component
  has unmounted.
  
  @​jfrolich in #​3490

Bug Fixes

• A fix has been applied to prevent an unchanging loading state when an error occurs after a refetch, that is the same as the previous error.
  
  @​jet2jet in #​3477
• Add back in the removed ChildDataProps and ChildMutateProps types.
  
  @​hwillson in #​3495
• Make sure onCompleted is called each time a useLazyQuery based query completes, after the execution function is called.
  
  @​hwillson in #​3497

v3.1.0

Compare Source

Potentially Breaking Change

• Change the default query data state from {} to undefined. This change aligns all parts of the React Apollo query cycle so that data is always undefined if there is no data, instead of data being converted into an empty object. This change impacts the initial query response, initial SSR response, data value when errors occur, data value when skipping, etc. All of these areas are now aligned to only ever return a value for data if there really is a value to return (instead of making it seem like there is one by converting to {}).
  
  @​hwillson in #​3388

Bug Fixes

• Adds support for the skip option when using useSubscription.
  
  @​n1ru4l in #​3356
• Makes sure refetch, fetchMore, updateQuery, startPolling, stopPolling, and subscribeToMore maintain a stable identity when they're passed back alongside query results.
  
  @​hwillson in #​3422
• Fixed problematic re-renders that were caused by using fetchMore.updateQuery with notifyOnNetworkStatusChange set to true. When notifyOnNetworkStatusChange is true, re-renders will now wait until updateQuery has completed, to make sure the updated data is used during the render.
  
  @​hwillson in #​3433
• Add client to the useMutation result.
  
  @​joshalling in #​3417
• Prevent inline onError and onCompleted callbacks from being part of the internal memoization that's used to decide when certain after render units of functionality are run, when using useQuery. This fixes issues related to un-necessary component cleanup, like error disappearing from results when it should be present.
  
  @​dylanwulf in #​3419
• useLazyQuery's execution function can now be called multiple times in a row, and will properly submit network requests each time called, when using a fetch policy of network-only.
  
  @​hwillson in #​3453
• SSR enhancements to support network-only and cache-and-network fetch policies, along with changes to ensure disabled SSR queries are not fired.
  
  @​mikebm in #​3435
• Remove void from the MutationFunction's returned Promise types.
  
  @​hwillson in #​3458
• Prevent duplicate onCompleted calls during the same query execution cycle.
  
  @​hwillson in #​3461
• Make sure polling is stopped when a component is unmounted.
  
  @​dqunbp in #​3273
• Documentation fixes.
  
  @​SeanRoberts in #​3380

v3.0.1

Compare Source

Improvements

• Documentation updates.
  
  @​joshalling in #​3324

Bug Fixes

• Dedupe onError callback calls and ensure refetch sets loading state properly.
  
  @​hwillson in #​3339
• Add missing useLazyQuery export to the react-apollo (all) package.
  
  @​hwillson in #​3320
• Remove void from being one of the MutationTuple mutate function possible generics. This will make it easier to properly destructure results returned by the mutate function Promise.
  
  @​hwillson in #​3334
• Export MockedProviderProps and MockedProviderState from @apollo/react-testing.
  
  @​hwillson in #​3337
• Add @types/react as a peer dep, to address potential TS compilation errors when using ApolloProvider.
  
  @​zkochan in #​3278
• Make sure error's are maintained after re-renders, when they should be.
  
  @​hwillson in #​3362

v3.0.0

Compare Source

Overview

This major release includes a large refactoring of the existing React Apollo codebase, to introduce new improvements, changes, features and bug fixes. The biggest new features are:

• Provides new useQuery, useLazyQuery, useMutation, useSubscription, and useApolloClient hooks, following React's Hooks API.
• Maintains support for React Apollo's graphql HOC and render proper components.
• Introduces a new monorepo structure, with separately published packages, making it easier to use just the parts of React Apollo you're interested in:
  • @apollo/react-common
  • @apollo/react-hooks
  • @apollo/react-components
  • @apollo/react-hoc
  • @apollo/react-ssr
  • @apollo/react-testing
• Thorough codebase pruning and cleaning to reduce the overall React Apollo bundle size.
• And more!

Consult the Hooks migration guide for more details around upgrading. For more information regarding how to use the new hooks, please consult the updated React Apollo docs (all docs have been updated to be hooks first).

Breaking Changes

• The minimum supported React version is now 16.8.

• The react-apollo@3 package preserves most of the functionality of react-apollo@2 by re-exporting existing components and functions from @apollo/react-components and @apollo/react-hoc. If you want to use Hooks, Components, or HOC directly, import the new @apollo/react-hooks, @apollo/react-components, and/or @apollo/react-hoc packages instead.

• React Apollo testing utilities are no longer available as part of the react-apollo package. They should now be imported from the new @apollo/react-testing package.

• The deprecated walkTree function has been removed (9b24d756).

• The deprecated GraphqlQueryControls and MutationFunc types have been removed (ade881f0).

• Preact is no longer supported (b742ae63).

• Various Typescript type changes. Since we've introduced a third way of managing data with React (Hooks), we had to rework many of the existing exported types to better align with the Hooks way of doing things. Base types are used to hold common properties across Hooks, Components and the graphql HOC, and these types are then extended when needed to provide properties that are specific to a certain React paradigm
  (30edb1b0 and
  3d138db3).

• catchAsyncError, wrap, and compose utilities have been removed
  (2c3a262, 7de864e, and e6089a7).

  Previously, compose was imported then exported directly from lodash using flowRight. To keep using compose, install the lodash.flowright package, then update your compose imports as:

  import compose from 'lodash.flowright';

• Render prop components (Query, Mutation and Subscription) can no longer be extended. In other words, this is no longer possible:

  class SomeQuery extends Query<SomeData, SomeVariables> {}

  All class based render prop components have been converted to functional components, so they could then just wrap their hook based equivalents (useQuery, useMutation, useSubscription).

  While we recommend switching over to use the new hooks as soon as possible, if you're looking for a stop gap you can consider typing a Query component in a similar fashion, like:

  export const SomeQuery = () => (
    <Query<SomeData, SomeVariables> query={SOME_QUERY} ...>
      {({ data }) => {
        return <div> ... things happen... </div>;
      }}
    </Query>
  );

v2.5.8

Compare Source

2.5.8 (2019-06-21)

Bug Fixes

• Makes the use of apollo-client 2.6.3's ObservableQuery.resetQueryStoreErrors
  method optional, for people who can't update to react-apollo's new
  apollo-client peer dep of 2.6.3.
  @​hwillson in #​3151

v2.5.7

Compare Source

Improvements

• Make sure MockedProvider is using the proper CJS/ESM bundle, when
  referencing ApolloProvider.
  
  @​jure in #​3029.
• Adjust the ApolloContext definition to play a bit more nicely with
  React.createContext types.
  
  @​JoviDeCroock in #​3018
• The result of a mutation is now made available to the wrapped component,
  when using the graphql HOC.
  
  @​andycarrell in #​3008
• Check equality of stringified variables in the MockLink to improve
  debugging experience used by MockedProvider.
  
  @​evans in #​3078

Bug Fixes

• Removed leftover apollo-client@beta peer dep.
  
  @​brentertz in #​3064
• Stop setting optional input to null, when using the graphql HOC.
  
  @​ZhengYuTay in #​3056
• Fix typescript error caused by query being mandatory in the fetchMore signature.
  
  @​HsuTing in #​3065
• Fixes an issue that caused the Query component to get stuck in an always
  loading state, caused by receiving an error (meaning subsequent valid
  responses couldn't be handled). The Query component can now handle an
  error in a response, then continue to handle a valid response afterwards.
  
  @​hwillson in #​3107
• Reorder Subscription component code to avoid setting state on unmounted
  component.
  
  @​jasonpaulos in #​3139
• Fix component stuck in loading state for network-only fetch policy.
  
  @​jasonpaulos in #​3126

v2.5.6

Compare Source

Improvements

• Both the Query component and graphql HOC now accept a
  returnPartialData prop. This is an important new feature, that should
  help address a lot of open Apollo Client / React Apollo issues, so we'll
  explain it here with an example. Before this release, if you run a query
  that looks like:

  const GET_MEMBER = gql`
    query GetMember($id: ID!) {
      member(id: $id) {
        id
        name
      }
    }
  `;

  in one component, the results are cached, then you run a superset query like
  the following in another component:

  const GET_MEMBER_WITH_PLANS = gql`
    query GetMemberWithPlans($id: ID!) {
      member(id: $id) {
        id
        name
        plans {
          id
          title
          duration
        }
      }
    }
  `;

  Apollo Client will not re-use the partial data that was cached from the first
  query, when it preps and displays the second component. It can't find a
  cache hit for the full second query, so it fires the full query over the
  network.

  With this release, if you set a returnPartialData prop to true on the
  second component, the data available to that component will be
  automatically pre-loaded with the parts of the query that can be found in the
  cache, before the full query is fired over the network. This means you can
  do things like showing partial data in your components, while the rest of the
  data is being loaded over the network.

v2.5.5

Compare Source

Improvements

• Export the Apollo Context provider (ApolloContext).
  
  @​MrLoh in #​2961

v2.5.4

Compare Source

Bug Fixes

• Fixes Could not find "client" in the context of ApolloConsumer errors when
  using MockedProvider.
  
  @​hwillson in #​2907
• Ensure Query components using a fetchPolicy of no-cache have their
  data preserved when the components tree is re-rendered.
  
  @​hwillson in #​2914

Improvements

• Documentation updates.
  
  @​afenton90 in #​2932

v2.5.3

Compare Source

Bug Fixes

• Fixed an infinite loop caused by using setState in the
  onError / onCompleted callbacks of the Query component.
  
  @​chenesan in #​2751
• Fixed an issue that prevented good results from showing up in a Query
  component, after an error was received, variables were adjusted, and then
  the good data was fetched.
  
  @​MerzDaniel in #​2718
• Fixed an issue that prevented Query component updates from firing (under
  certain circumstances) due to the internal lastResult value (that's used
  to help prevent unnecessary re-renders) not being updated.
  
  @​Glennrs in #​2840

Improvements

• MockedProvider now accepts a childProps prop that can be used to pass
  props down to a child component.
  
  @​miachenmtl in #​2482

• onCompleted callbacks now use a destructuring-friendly type definition.
  
  @​jozanza in #​2496

• @connection directives are now properly stripped from MockedResponse's,
  when using MockedProvider.
  
  @​ajmath in #​2523

• MockedProvider has been updated to stop setting a default resolvers
  value of {}, which means by default Apollo Client 2.5 local resolver
  functionality is not enabled when mocking with MockedProvider. This allows
  @client fields to be passed through the mocked link chain, like people
  were used to before AC 2.5. When using this default mode you will see a
  dev only warning message about this like:

  Found @​client directives in query but no client resolvers were specified.
  You can now pass apollo-link-state resolvers to the ApolloClient
  constructor.

  This message can be safely ignored. If you want to use MockedProvider
  with AC 2.5's new local resolver functionality, you can pass your local
  resolver map into the MockedProvider resolvers prop.
  
  @​ajmath in #​2524

• Improvements to the graphql HOC generics for fetchMore and refetch.
  
  @​EricMcRay in #​2525

• The ApolloProvider / ApolloConsumer implementations have been refactored
  to use React 16.3's new context API.
  
  @​wzrdzl in #​2540

• All dependencies and devDependencies have been updated to their latest
  versions, and related Typescript changes have been applied.
  
  @​hwillson in #​2873

v2.5.2

Compare Source

Bug Fixes

• Export Context type from types.ts instead of walkTree.ts,
  to reenable import { Context } from 'react-apollo' (which has been
  broken since 2.4.0).
  
  @​benjamn in #​2825

Improvements

• Add examples/rollup
  to enable application-level bundle measurement and demonstrate Rollup configuration best practices.
  
  @​benjamn in #​2839

• Bundle size reductions inspired by examples/rollup app.
  
  @​benjamn in #​2842

v2.5.1

Compare Source

Bug Fixes

• Make sure MockedProvider enables Apollo Client 2.5's local state handling,
  and allow custom / mocked resolvers to be passed in as props, and used with
  the created test ApolloClient instance.
  
  @​hwillson in #​2825

v2.5.0

Compare Source

Improvements

• Ready to be used with Apollo Client 2.5 and its new local state management
  features, as well as many overall code improvements to help reduce the React
  Apollo bundle size.
  
  #​2758
• A function can now be set as a MockedResponse result when using
  MockedProvider, such that every time the mocked result is returned,
  the function is run to calculate the result. This opens up new testing
  possibilities, like being able to verify if a mocked result was actually
  requested and received by a test.
  
  @​hwillson in #​2788